Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

core/error: add status code for before publish rule rejection #396

Merged
merged 1 commit into from
Nov 21, 2024
Merged

core/error: add status code for before publish rule rejection #396

merged 1 commit into from
Nov 21, 2024

Conversation

AndyTWF
Copy link
Collaborator

@AndyTWF AndyTWF commented Nov 12, 2024 •
edited by jira bot
Loading

Context

CHA-701

Description

For convenience, we add this error code so that it can be easily checked against.

Checklist

  • QA'd by the author.
  • Unit tests created (if applicable).
  • Integration tests created (if applicable).
  • Follow coding style guidelines found here.
  • TypeDoc updated (if applicable).
  • (Optional) Update documentation for new features.
  • Browser tests created (if applicable).
  • In repo demo app updated (if applicable).

Testing Instructions (Optional)

N/A

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 12, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot temporarily deployed to staging/pull/396/typedoc November 12, 2024 12:33 Inactive
@AndyTWF AndyTWF requested a review from a team November 12, 2024 12:33
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 12, 2024 •
edited
Loading

Coverage Report

Status Category Percentage Covered / Total
🟢 Lines 93.35% (🎯 92%) 3147 / 3371
🟢 Statements 93.35% (🎯 92%) 3147 / 3371
🟢 Functions 95.25% (🎯 92%) 241 / 253
🟢 Branches 93.63% (🎯 93%) 853 / 911
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/core/errors.ts 100% 100% 0% 100%
Generated in workflow #1788 for commit eec35f7 by the Vitest Coverage Report Action

@AndyTWF AndyTWF force-pushed the before-publish-rejection-error branch from 9799fda to 4557483 Compare November 13, 2024 08:59
@github-actions github-actions bot temporarily deployed to staging/pull/396/typedoc November 13, 2024 08:59 Inactive
@AndyTWF AndyTWF mentioned this pull request Nov 13, 2024
Merged
splindsay-92
splindsay-92 approved these changes Nov 14, 2024
View reviewed changes
Copy link
Contributor

@splindsay-92 splindsay-92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

src/core/errors.ts Outdated
* For example, a message may be rejected because it violates a moderation policy
* that bans profanity.
*/
MessageRejectedByBeforePublishRule = 42210,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to read this a few times because of the By in the middle, but I take it to mean it was rejected by a rule that runs before publish :D

@AndyTWF AndyTWF force-pushed the before-publish-rejection-error branch from 4557483 to d4da7da Compare November 20, 2024 17:03
@AndyTWF AndyTWF requested a review from splindsay-92 November 20, 2024 17:03
@AndyTWF
Copy link
Collaborator Author

AndyTWF commented Nov 20, 2024

One more check if you can please @splindsay-92 - added a moderation specific code :)

@github-actions github-actions bot temporarily deployed to staging/pull/396/typedoc November 20, 2024 17:04 Inactive
@AndyTWF
core/error: add status code for before publish rule rejection
eec35f7 
For convenience, we add this error code so that it can be easily checked
against.

[CHA-701]
@AndyTWF AndyTWF force-pushed the before-publish-rejection-error branch from d4da7da to eec35f7 Compare November 21, 2024 14:31
@AndyTWF AndyTWF enabled auto-merge November 21, 2024 14:31
@AndyTWF AndyTWF merged commit ee554e3 into main Nov 21, 2024
9 checks passed
@AndyTWF AndyTWF deleted the before-publish-rejection-error branch November 21, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@splindsay-92 splindsay-92 splindsay-92 approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AndyTWF @splindsay-92